Package | hl7.fhir.uv.cpg |
Type | CapabilityStatement |
Id | Id |
FHIR Version | R4 |
Source | http://hl7.org/fhir/uv/cpg/https://build.fhir.org/ig/HL7/cqf-recommendations/CapabilityStatement-cpg-common-patient-registry.html |
Url | http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry |
Version | 2.0.0 |
Status | active |
Date | 2023-12-11 |
Name | CPGCommonPatientRegistry |
Title | CPG Common Patient Registry |
Experimental | True |
Realm | uv |
Authority | hl7 |
Description | Describes the expected set of functionality required for a patient registry service that supports the common registration process defined in this implementation guide. |
Kind | requirements |
No resources found
OperationDefinition | |
cpg-common-patient-summary | CPG Common Patient Summary |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement cpg-common-patient-registry
xml
, json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Patient | y | y | y | y | active, birthdate, name, identifier | $$match , $$summary |
read
, update
, create
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | active | token | |
SHALL | birthdate | date | |
SHALL | name | string | |
SHALL | identifier | token |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $$match | |
SHALL | $$summary |
{
"resourceType" : "CapabilityStatement",
"id" : "cpg-common-patient-registry",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement cpg-common-patient-registry</b></p><a name=\"cpg-common-patient-registry\"> </a><a name=\"hccpg-common-patient-registry\"> </a><a name=\"cpg-common-patient-registry-en-US\"> </a><h2 id=\"title\">CPG Common Patient Registry</h2><ul><li>Implementation Guide Version: 2.0.0 </li><li>FHIR Version: 4.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-12-11 </li><li>Published by: HL7 International / Clinical Decision Support </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Patient1-1\">Patient</a></td><td>�</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>active, birthdate, name, identifier</td><td/><td/><td><code>$$match</code>, <code>$$summary</code></td></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>update</code>, <code>create</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>active</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$$match</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-cpg-common-patient-summary.html\">$$summary</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}
],
"url" : "http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry",
"version" : "2.0.0",
"name" : "CPGCommonPatientRegistry",
"title" : "CPG Common Patient Registry",
"status" : "active",
"experimental" : true,
"date" : "2023-12-11",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"name" : "HL7 International / Clinical Decision Support",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "Describes the expected set of functionality required for a patient registry service that supports the common registration process defined in this implementation guide.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.0",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Patient",
"interaction" : [
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "create"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "active",
"type" : "token"
},
{
"name" : "birthdate",
"type" : "date"
},
{
"name" : "name",
"type" : "string"
},
{
"name" : "identifier",
"type" : "token"
}
],
"operation" : [
{
"name" : "$match",
"definition" : "http://hl7.org/fhir/OperationDefinition/Patient-match"
},
{
"name" : "$summary",
"definition" : "http://hl7.org/fhir/uv/cpg/OperationDefinition/cpg-common-patient-summary"
}
]
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.